# SUMMARY.md

The summary file is used by mdBook to know what chapters to include,
in what order they should appear, what their hierarchy is and where the source files are.
Without this file, there is no book.

Even though `SUMMARY.md` is a markdown file, the formatting is very strict to
allow for easy parsing. Let's see how you should format your `SUMMARY.md` file.

#### Allowed elements

1. ***Title*** It's common practice to begin with a title, generally
   <code class="language-markdown"># Summary</code>.
   But it is not mandatory, the parser just ignores it. So you can too
   if you feel like it.

2. ***Prefix Chapter*** Before the main numbered chapters you can add a couple of elements that will not be numbered. This is useful for
   forewords, introductions, etc. There are however some constraints. You can not nest prefix chapters, they should all be on the root level. And you can not add prefix chapters once you have added numbered chapters.
   ```markdown
   [Title of prefix element](relative/path/to/markdown.md)
   ```

3. ***Numbered Chapter*** Numbered chapters are the main content of the book, they will be numbered and can be nested,
   resulting in a nice hierarchy (chapters, sub-chapters, etc.)
   ```markdown
   - [Title of the Chapter](relative/path/to/markdown.md)
   ```
   You can either use `-` or `*` to indicate a numbered chapter.

4. ***Sufix Chapter*** After the numbered chapters you can add a couple of non-numbered chapters. They are the same as prefix chapters but come after the numbered chapters instead of before.

All other elements are unsupported and will be ignored at best or result in an error.
